Skip to main content

RTP INBOUND

The RTP IN API enables to process incoming Real-Time Payments (RTP) transactions instantly.

Method: POST​

{{localCEUrl}}/analytics/rest/eventApi/event

Headers​

NameValue
Content-Typeapplication/json

Example​

Payload Parameters
ParameterDescription

InstructionIdentification

Mandatory

String

Unique identifier of the payment instruction

Example – "f9a820da-7bcd-4941-b85c-201169ccf41a"

EndToEndIdentification

Optional

String

Unique identifier to track the transaction any time during the process

Example – "31fe4401-d804-441e-b67a-44016b99b08f"

Reason

Optional

String

Reason or purpose given for the transaction

Example – "Loan Repayment"

Channel

Optional

String

Channel through which the transaction happens

Example – "TCH"

TransactionType

Optional

String

Type of transaction

Example – "RTP_IN"

TransactionCode

Optional

String

Specific code for the transaction type

Example – "TCH_RTP_IN"

Source

Optional

String

Name of the source system from where the payment request is initiated

Example – "LEDGER"

TransactionAmount

Mandatory

Object

Amount

Mandatory

String

Amount of the transaction

Example – "21.00"

Currency

Mandatory

String

Currency type of the transaction amount

Example – "USD"

Debtor

Required

Object

CustomerType

Optional

String

Customer type of the debtor (sender), which can possibly be the ‘Account Holder', ‘Non-account Holder', ‘Account Holder Business' or ‘TSP'

Example – "EXTERNAL"

UserType

Optional

String

Type of the user based on user-role, which can be ‘Individual' or ‘Legal Rep'

Example – "UNKNOWN"

Identification

Optional

String

Individual ID of the debtor

Example – "894100103"

IdentificationType

Optional

String

Type of identification used for individual ID

Example – "SSN"

CustomerNumber

Optional

String

Unique ID provided for the debtor as a customer

Example – "894100103"

InstitutionNumber

Optional

String

Unique ID that identifies the financial institution

Example – "123456789012345"

Name

Required

String

Customer name of the debtor

Example – "Melanie Oconnell"

NameInFile

Optional

String

Name of the debtor given in the payment instruction

Example – "Melanie Oconnel"

Gender

Optional

String

Gender of the debtor as a customer

Example – "Male"

DebtorDateOfBirth

Optional

Object

Year

Optional

String

Birth year of the debtor

Example – "1974"

Month

Optional

String

Birth month of the debtor

Example – "05"

Day

Optional

String

Birth year of the debtor

Example – "17"

DateOfBirth

Optional

String

Date of birth of debtor in YYYYMMDD format

Example – "19740517"

DebtorPostalAddress

Optional

Object

AddressType

Optional

String

Address type of debtor

Example – ""

AddressLine1

Optional

String

Line 1 of debtor address

Example – "4842 Giraffe Hill Drive"

AddressLine2

Optional

String

Line 2 of debtor address

Example – "Apt 304"

City

Optional

String

City name of the debtor address

Example – "Dallas"

State

Optional

String

State of the debtor address

Example – "TX"

ZipCode

Optional

String

Zip code of debtor address location

Example – "75244"

CountryCode

Optional

String

Country code of debtor's country

Example – "840"

Nationality

Optional

String

Nationality of the debtor

Example – "USA"

Country

Optional

String

Country of the debtor's location

Example – "USA"

DebtorContact

Optional

Object

PrimaryEmail

Optional

String

Contact email ID of the debtor

Example – "melanie@gmail.com "

PrimaryPhone

Optional

String

Contact phone number of the debtor

Example – "0076540017822"

DebtorAccount

Optional

Object

AccountNumber

Optional

String

Account number of the debtor

Example – "200502391928095"

AccountType

Optional

String

Type of the debtor's account

Example – "EXTERNAL"

AccountName

Optional

String

Debtor's account name

Example – "EXTERNAL"

Institution

Optional

Object

Name

Optional

String

Name of the debtor account financial institution

Example – "JPMORGAN CHASE BANK, NA"

Identification

Optional

String

Identification code of the debtor account financial institution,

which is possibly the routing number

Example – "234567891"

IdentificationType

Optional

String

Identification type of the debtor account financial institution

Example – "ABA"

DebtorGeoLocation

Optional

Object

Latitude

Optional

String

Geographical latitude of debtor's location

Example – "13.02354160"

Longitude

Optional

String

Geographical longitude of debtor's location

Example – "80.14923669"

Creditor

Required

Object

CustomerType

Optional

String

Customer type of the creditor (receiver), which can possibly be the ‘Account Holder', ‘Account Holder Business' or ‘TSP'

Example – "ACCOUNT_HOLDER_BUSINESS"

UserType

Optional

String

User type of the creditor

Example – "INDIVIDUAL"

Identification

Optional

String

Individual ID of the creditor

Example – "994140005"

IdentificationType

Optional

String

Type of identification used for individual ID

Example – "SSN"

CustomerNumber

Optional

String

Unique ID provided for the creditor as a customer

Example – "994140005"

Name

Optional

String

Customer name of the creditor

Example – "Sally Granger"

CreditorAccount

Optional

Object

AccountNumber

Optional

String

Account number of the creditor

Example – "200279991025724"

AccountType

Optional

String

Type of the creditor's account

Example – "CHECKING"

AccountName

Optional

String

Creditor's account name

Example – "INTERNAL"

Institution

Optional

Object

Identification

Optional

String

Identification code of the creditor account financial institution, which is possibly the routing number

Example – "011102502"

IdentificationType

Optional

String

Identification type of the creditor account financial institution

Example – "ABA"

Name

Optional

String

Name of the creditor account financial institution

Example – "Union Savings Bank"

CreditorDateOfBirth

Optional

Object

Year

Optional

String

Birth year of the creditor

Example – "1970"

Month

Optional

String

Birth month of the creditor

Example – "11"

Day

Optional

String

Birth year of the creditor

Example – "15"

CreditorPostalAddress

Optional

Object

AddressType

Optional

String

Address type of creditor

Example – "HOUSE"

AddressLine1

Optional

String

Line 1 of creditor address

Example – "4118 Sigley Road"

AddressLine2

Optional

String

Line 2 of creditor address

Example – "Suite C"

City

Optional

String

City name of the creditor address

Example – "Hays"

State

Optional

String

State of the creditor address

Example – "KS"

ZipCode

Optional

String

Zip code of creditor address location

Example – "67601"

CountryCode

Optional

String

Country code of creditor country

Example – "840"

Nationality

Optional

String

Nationality of the creditor

Example – "USA"

Country

Optional

String

Country of the creditor's location

Example – "USA"

CreditorContact

Optional

Object

PrimaryEmail

Optional

String

Contact email ID of the creditor

Example – "sally@gmail.com"

PrimaryPhone

Optional

String

Contact phone number of the creditor

Example – "00178500146156"

FedDetails

Object

FedSender

Optional

Object

Identification

Optional

String

Identification code of the sender bank of FED

Example – "021000021"

IdentificationType

Optional

String

Identification type of the sender bank of FED

Example – "ABA"

Name

Optional

String

Name of the sender bank of FED

Example – "JPMORGAN CHASE BANK"

FedReceiver

Optional

Object

Identification

Optional

String

Identification code of the receiver bank of FED

Example – "011102502"

IdentificationType

Optional

String

Identification type of the receiver bank of FED

Example – "ABA"

Name

Optional

String

Name of the receiver bank of FED

Example – "Union Savings Bank"

Risk

Optional

Object

MachineFingerPrint

Optional

Object


curl --location 'http://localhost:8080/BiReport/rest/eventApi/event' \
--header 'Content-Type: application/json' \
--data-raw '{"InstructionIdentification":"f9a820da-7bcd-4941-b85c-201169ccf41a","EndToEndIdentification":"31fe4401-d804-441e-b67a-44016b99b08f","Reason":"Loan Repayment","Channel":"TCH","TranactionType":"RTP_IN","TranactionCode":"TCH_RTP_IN","Source":"LEDGER","TransactionAmount":{"Amount":"21.00","Currency":"USD"},"Debtor":{"CustomerType":"EXTERNAL","UserType":"UNKNOWN","Identification":"894100103","IdentificationType":"SSN","CustomerNumber":"894100103","InstitutionNumber":"123456789012345","Name":"Melanie Oconnell","NameInFile":"Melanie Oconnel","Gender":"Male"},"DebtorDateOfBirth":{"Year":"1974","Month":"05","Day":"17","DateOfBirth":"19740517"},"DebtorPostalAddress":{"AddressType":"","AddressLine1":"4842 Giraffe Hill Drive","AddressLine2":"Apt 304","City":"Dallas","State":"TX","ZipCode":"75244","CountryCode":"840","Nationality":"USA"},"DebtorContact":{"PrimaryEmail":"melanie@gmail.com","PrimaryPhone":"0076540017822"},"DebtorAccount":{"AccountNumber":"200502391928095","AccountType":"EXTERNAL","AccountName":"EXTERNAL","Institution":{"Name":"JPMORGAN CHASE BANK, NA","Identification":"234567891","IdentificationType":"ABA"}},"DebtorGeoLocation":{"Latitude":"13.02354160","Longitude":"80.14923669"},"Creditor":{"CustomerType":"ACCOUNT_HOLDER_BUSINESS","UserType":"INDIVIDUAL","Identification":"994140005","IdentificationType":"SSN","CustomerNumber":"994140005","Name":"Sally Granger"},"CreditorAccount":{"AccountNumber":"200279991025724","AccountType":"CHECKING","AccountName":"INTERNAL","Institution":{"Identification":"011102502","IdentificationType":"ABA","Name":"Union Savings Bank"}},"CreditorDateOfBirth":{"Year":"1970","Month":"11","Day":"15"},"CreditorPostalAddress":{"AddressType":"HOUSE","AddressLine1":"4118 Sigley Road","AddressLine2":"Suite C","City":"Hays","State":"KS","ZipCode":"67601","CountryCode":"840","Nationality":"USA","Country":"USA"},"CreditorContact":{"PrimaryEmail":"sally@gmail.com","PrimaryPhone":"00178500146156"},"FedDetails":{"FedSender":{"Identification":"021000021","IdentificationType":"ABA","Name":"JPMORGAN CHASE BANK"},"FedReceiver":{"Identification":"011102502","IdentificationType":"ABA","Name":"Union Savings Bank"}},"Risk":{"MachineFingerPrint":{}}}'

Body​


{
  "InstructionIdentification": "f9a820da-7bcd-4941-b85c-201169ccf41a",
  "EndToEndIdentification": "31fe4401-d804-441e-b67a-44016b99b08f",
  "Reason": "Loan Repayment",
  "Channel": "TCH",
  "TranactionType": "RTP_IN",
  "TranactionCode": "TCH_RTP_IN",
  "Source": "LEDGER",
  "TransactionAmount": {
    "Amount": "21.00",
    "Currency": "USD"
  },
  "Debtor": {
    "CustomerType": "EXTERNAL",
    "UserType": "UNKNOWN",
    "Identification": "894100103",
    "IdentificationType": "SSN",
    "CustomerNumber": "894100103",
    "InstitutionNumber": "123456789012345",
    "Name": "Melanie Oconnell",
    "NameInFile": "Melanie Oconnel",
    "Gender": "Male"
  },
  "DebtorDateOfBirth": {
    "Year": "1974",
    "Month": "05",
    "Day": "17",
    "DateOfBirth": "19740517"
  },
  "DebtorPostalAddress": {
    "AddressType": "",
    "AddressLine1": "4842 Giraffe Hill Drive",
    "AddressLine2": "Apt 304",
    "City": "Dallas",
    "State": "TX",
    "ZipCode": "75244",
    "CountryCode": "840",
    "Nationality": "USA"
  },
  "DebtorContact": {
    "PrimaryEmail": "melanie@gmail.com",
    "PrimaryPhone": "0076540017822"
  },
  "DebtorAccount": {
    "AccountNumber": "200502391928095",
    "AccountType": "EXTERNAL",
    "AccountName": "EXTERNAL",
    "Institution": {
      "Name": "JPMORGAN CHASE BANK, NA",
      "Identification": "234567891",
      "IdentificationType": "ABA"
    }
  },
  "DebtorGeoLocation": {
    "Latitude": "13.02354160",
    "Longitude": "80.14923669"
  },
  "Creditor": {
    "CustomerType": "ACCOUNT_HOLDER_BUSINESS",
    "UserType": "INDIVIDUAL",
    "Identification": "994140005",
    "IdentificationType": "SSN",
    "CustomerNumber": "994140005",
    "Name": "Sally Granger"
  },
  "CreditorAccount": {
    "AccountNumber": "200279991025724",
    "AccountType": "CHECKING",
    "AccountName": "INTERNAL",
    "Institution": {
      "Identification": "011102502",
      "IdentificationType": "ABA",
      "Name": "Union Savings Bank"
    }
  },
  "CreditorDateOfBirth": {
    "Year": "1970",
    "Month": "11",
    "Day": "15"
  },
  "CreditorPostalAddress": {
    "AddressType": "HOUSE",
    "AddressLine1": "4118 Sigley Road",
    "AddressLine2": "Suite C",
    "City": "Hays",
    "State": "KS",
    "ZipCode": "67601",
    "CountryCode": "840",
    "Nationality": "USA",
    "Country": "USA"
  },
  "CreditorContact": {
    "PrimaryEmail": "sally@gmail.com",
    "PrimaryPhone": "00178500146156"
  },
  "FedDetails": {
    "FedSender": {
      "Identification": "021000021",
      "IdentificationType": "ABA",
      "Name": "JPMORGAN CHASE BANK"
    },
    "FedReceiver": {
      "Identification": "011102502",
      "IdentificationType": "ABA",
      "Name": "Union Savings Bank"
    }
  },
  "Risk": {
    "MachineFingerPrint": {}
  }
}

Response: 200​

Payload Parameters
ParameterDescription

id

String

ID of the request

Example – "04e3c7d6-216e-483e-b1ae-cd9870421ed5"

jsonrpc

String

JSON-RPC version used for the API

Example – "2.0"

method

String

API method

Example – "ce.event"

result

Object

resp

String

Type of response

Example – "event"

status

String

Status of the event

Example – "1"

riskScore

Number

Estimated Risk score of the transaction

Example – 960

signalScore

Number

Signal reliability score of the transaction

Example – 844

scenarioScore

Number

Score of specific scenarios related to the transaction event

Example – 0

tokenScore

Number

Score of token authentication used in the transaction

Example – 0

categoryScore

Number

Event category score of transaction

Example – 0

ofacConfidentScore

Number

Estimated score of compliance with OFAC regulations

Example – 76

debtorProfileId

String

Unique ID of debtor profile

Example – "9C1C1A87D297C038D71DD1623F03191D"

creditorProfileId

String

Unique ID of creditor profile

Example – "0A29E788B63F6CE7FAC232BC3839D1DB"

error

null

Shows information, if any error occurs during transaction

Example – null


{
  "id": "04e3c7d6-216e-483e-b1ae-cd9870421ed5",
  "jsonrpc": "2.0",
  "method": "ce.event",
  "result": {
    "resp": "event",
    "status": "1",
    "riskScore": 960,
    "signalScore": 884,
    "scenarioScore": 0,
    "tokenScore": 0,
    "categoryScore": 0,
    "ofacConfidentScore": 76,
    "debtorProfileId": "9C1C1A87D297C038D71DD1623F03191D",
    "creditorProfile": "0A29E788B63F6CE7FAC232BC3839D1DB"
  },
  "error": null
}